Package-level declarations

Starting from June 2024, webhook messages from PortOne includes headers as specified in Standard Webhooks. This provides an easy way of securing webhook endpoints. Instead of relying on the IP addresses of the origin, the message itself can be verified. (i.e. It is NOT required to set up IP filters when the messages are verified by itself.)

The WebhookVerifier class implements a simple webhook verification logic. The WebhookVerificationException is thrown when the verification fails.

After a new webhook secret is issued to replace the existing secret, multiple signatures are included in the messages for a certain amount of time during which verifiers with either secret can verify the message. This grace period can be used to migrate your server to the new secret.

Types

Link copied to clipboard
@Serializable
sealed interface Webhook

2024-04-25 버전의 웹훅 형식

Link copied to clipboard
@Serializable
sealed interface WebhookBillingKey : Webhook

빌링키 발급 관련

Link copied to clipboard
@Serializable
sealed interface WebhookBillingKeyData

빌링키 발급 관련 웹훅을 트리거한 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

빌링키가 삭제되었을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

빌링키 발급이 실패했을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

빌링키가 발급되었을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

빌링키 발급창이 열렸을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

빌링키가 업데이트되었을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard
@Serializable
@SerialName(value = "BillingKey.Deleted")
data class WebhookBillingKeyDeleted : WebhookBillingKey

빌링키가 삭제되었을 때

Link copied to clipboard
@Serializable
@SerialName(value = "BillingKey.Failed")
data class WebhookBillingKeyFailed : WebhookBillingKey

빌링키 발급이 실패했을 때

Link copied to clipboard
@Serializable
@SerialName(value = "BillingKey.Issued")
data class WebhookBillingKeyIssued : WebhookBillingKey

빌링키가 발급되었을 때

Link copied to clipboard
@Serializable
@SerialName(value = "BillingKey.Ready")
data class WebhookBillingKeyReady : WebhookBillingKey

빌링키 발급창이 열렸을 때

Link copied to clipboard
@Serializable
@SerialName(value = "BillingKey.Updated")
data class WebhookBillingKeyUpdated : WebhookBillingKey

빌링키가 업데이트되었을 때

Link copied to clipboard
@Serializable
sealed interface WebhookTransaction : Webhook

결제 관련

Link copied to clipboard
@Serializable
sealed interface WebhookTransactionCancelled : WebhookTransaction

결제 취소 관련

Link copied to clipboard
@Serializable
@SerialName(value = "Transaction.Cancelled")
data class WebhookTransactionCancelledCancelled : WebhookTransactionCancelled

결제가 완전 취소되었을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard
@Serializable
@SerialName(value = "Transaction.CancelPending")
data class WebhookTransactionCancelledCancelPending : WebhookTransactionCancelled

(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때

Link copied to clipboard

결제 취소 관련 웹훅을 트리거한 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

결제가 완전 취소되었을 때 이벤트의 실제 세부 내용입니다.

(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때 이벤트의 실제 세부 내용입니다.

결제가 부분 취소되었을 때 이벤트의 실제 세부 내용입니다.

@Serializable
@SerialName(value = "Transaction.PartialCancelled")
data class WebhookTransactionCancelledPartialCancelled : WebhookTransactionCancelled

결제가 부분 취소되었을 때

Link copied to clipboard
@Serializable
@SerialName(value = "Transaction.Confirm")
data class WebhookTransactionConfirm : WebhookTransaction

컨펌 프로세스에서 승인 요청을 받았을 때

Link copied to clipboard
@Serializable
sealed interface WebhookTransactionData

결제 관련 웹훅을 트리거한 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

(결제 취소가 비동기로 수행되는 경우) 결제 취소를 요청했을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

결제(예약 결제 포함)가 실패했을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard

결제(예약 결제 포함)가 승인되었을 때 이벤트의 실제 세부 내용입니다. (모든 결제 수단)

Link copied to clipboard

결제 승인 대기 상태가 되었을 때 이벤트의 실제 세부 내용입니다. (해외 결제시 발생 가능)

Link copied to clipboard

결제창이 열렸을 때 이벤트의 실제 세부 내용입니다.

가상계좌가 발급되었을 때 이벤트의 실제 세부 내용입니다.

Link copied to clipboard
@Serializable
@SerialName(value = "Transaction.Failed")
data class WebhookTransactionFailed : WebhookTransaction

결제(예약 결제 포함)가 실패했을 때

Link copied to clipboard
@Serializable
@SerialName(value = "Transaction.Paid")
data class WebhookTransactionPaid : WebhookTransaction

결제(예약 결제 포함)가 승인되었을 때 (모든 결제 수단)

Link copied to clipboard
@Serializable
@SerialName(value = "Transaction.PayPending")
data class WebhookTransactionPayPending : WebhookTransaction

결제 승인 대기 상태가 되었을 때 (해외 결제시 발생 가능)

Link copied to clipboard
@Serializable
@SerialName(value = "Transaction.Ready")
data class WebhookTransactionReady : WebhookTransaction

결제창이 열렸을 때

Link copied to clipboard
@Serializable
@SerialName(value = "Transaction.VirtualAccountIssued")
data class WebhookTransactionVirtualAccountIssued : WebhookTransaction

가상계좌가 발급되었을 때

Link copied to clipboard

Verifies webhook messages as specified in Standard Webhooks.